Skip to content

{KeyVault} Support quoted object id for set-policy and delete-policy#13146

Open
bim-msft wants to merge 2 commits intoAzure:devfrom
bim-msft:bim_kv_fix_quote
Open

{KeyVault} Support quoted object id for set-policy and delete-policy#13146
bim-msft wants to merge 2 commits intoAzure:devfrom
bim-msft:bim_kv_fix_quote

Conversation

@bim-msft
Copy link
Copy Markdown
Contributor

@bim-msft bim-msft commented Apr 24, 2020

Support for #11950

The case is when user try to obtain the object id using the following command (-o json):

PRINCIPAL_ID=$(az webapp show -n $AZ_FUNC_NAME -g $RESOURCE_GROUP_NAME --query 'identity.principalId' -o json)
echo "principalId: $PRINCIPAL_ID"

The ID will be quoted like this:

principalId: "02c27055-efb4-4b9d-bd5d-acd671ea5a10"

This quoted ID cannot be passed into the command:

az keyvault set-policy -n {kv} --object-id $PRINCIPAL_ID --key-permissions get list
An invalid value was provided for 'accessPolicies'.

This checklist is used to make sure that common guidelines for a pull request are followed.

@bim-msft bim-msft requested a review from fengzhou-msft as a code owner April 24, 2020 03:58
@bim-msft bim-msft requested a review from yungezz April 24, 2020 03:58
@bim-msft bim-msft added this to the S169 - For Build milestone Apr 24, 2020
@bim-msft bim-msft self-assigned this Apr 24, 2020
@bim-msft bim-msft added the KeyVault az keyvault label Apr 24, 2020
@bim-msft bim-msft linked an issue Apr 24, 2020 that may be closed by this pull request
attrs = ['object_id', 'spn', 'upn']
for attr in attrs:
if getattr(ns, attr):
setattr(ns, attr, getattr(ns, attr).strip('"'))
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for upn, is it safe to strip " ? what's the name convention? suggest only change object_id for now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for upn, is it safe to strip " ? what's the name convention? suggest only change object_id for now.

Most of UPN names are email-like: https://docs.microsoft.com/en-us/azure/active-directory/hybrid/plan-connect-userprincipalname
As far as I know there is also a type of UPN for external users like this: bim_microsoft.com#EXT#@AzureSDKTeam.onmicrosoft.com

Both formats don't have leading or tailing quotes.
But in case that there are maybe some unknown formats may have quotes, I will keep the original format for UPN and SPN. Will investigate them again when we have new user ask.

@bim-msft bim-msft changed the title {KeyVault} Support quoted object id, spn, upn for set-policy and delete-policy {KeyVault} Support quoted object id for set-policy and delete-policy Apr 24, 2020
@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Apr 24, 2020

Key Vault

@bim-msft
Copy link
Copy Markdown
Contributor Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 2 pipeline(s).

@fengzhou-msft
Copy link
Copy Markdown
Member

fengzhou-msft commented Apr 25, 2020

While the change LGTM, this is a very common usage in other commands as well, we may need to further consider fixing it in the core. Probably remove quotes in --query result if it has no spaces.

@bim-msft
Copy link
Copy Markdown
Contributor Author

bim-msft commented May 4, 2020

While the change LGTM, this is a very common usage in other commands as well, we may need to further consider fixing it in the core. Probably remove quotes in --query result if it has no spaces.

Graceful solution. As this is not urgent, I will change the implementation in the same PR later.

@bim-msft bim-msft modified the milestones: S169 - For Build, S170 May 4, 2020
@bim-msft bim-msft modified the milestones: S170, S174 Jul 3, 2020
@bim-msft bim-msft modified the milestones: S174, Backlog Aug 24, 2020
@yungezz yungezz assigned fengzhou-msft and unassigned bim-msft Dec 22, 2020
@fengzhou-msft
Copy link
Copy Markdown
Member

fengzhou-msft commented Feb 4, 2021

Using -o tsv instead of -o json would strip the double quotes. In the case to use the output of a CLI command in a downstream command, we should use -o tsv and I don't think we need to add support for -o json in this case as well.

@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@bim-msft please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

az keyvault set-policy: passing a variable to --object-id fails.

5 participants